DescribeStrategyExecDetail
Description
call the DescribeStrategyExecDetail interface to query the result details of the latest check performed by a single baseline detection policy, including the time of the latest check performed, the number of detected risk items, and the risk details of the baseline configuration.
Request Method
POST
Request Path
/apsara/route/aegis/DescribeStrategyExecDetail
Request Parameters Common Parameters
| Name | Location | Type | Required | Sample value | Description |
|---|---|---|---|---|---|
| SourceIp | BODY | string | No | 1.2.3.4 | access source IP address. |
| regionId | BODY | string | Yes | No sample value for this parameter. | region id |
| StrategyId | BODY | integer | Yes | 1 | baseline detection policy ID. description to query the detection results of a single baseline detection policy, you need to provide the ID of the baseline policy, which can be obtained by DescribeStratety interface. |
| version | BODY | string | No | 2016-01-01 | version of api |
Return data
| Name | Type | Sample value | Description |
|---|---|---|---|
| EndTime | string | 2019-01-08 20:11:20 | baseline check execution end time. |
| RequestId | string | 09322632-4668-4AD9-BD0D-32757DEFBBA6 | request ID of the result. |
| Percent | string | 100% | execution progress. |
| IP | string | 1.2.3.4 | the IP address of the server instance performing the baseline check. |
| StartTime | string | 2019-01-08 19:41:12 | baseline check execution start time. |
| SuccessCount | integer | 81 | baseline check status is passed . |
| IntranetIp | string | 1.2.3.5 | intranet IP. |
| FailedEcsList | array | No sample value for this parameter. | list of servers where baseline risk items are detected. |
| Reason | string | Detect timeout | the reason why the baseline check failed. |
| Source | string | Manual | baseline check execution type. Schedule: Periodic automatic check Manual: real-time manual check |
| InstanceName | string | Test -20180703 | instance name. |
| FailCount | integer | 94 | number of risk items that failed the baseline check. |
| InProcessCount | integer | 0 | The status is the number of baseline check tasks being executed. |
Example
Successful Response example
{
"EndTime":"2019-01-08 20:11:20",
"RequestId":"09322632-4668-4AD9-BD0D-32757DEFBBA6",
"Percent":"100%",
"IP":"1.2.3.4",
"StartTime":"2019-01-08 19:41:12",
"SuccessCount":"81",
"IntranetIp":"1.2.3.5",
"FailedEcsList":"",
"Reason":"Detect timeout",
"Source":"Manual",
"InstanceName":"Test -20180703",
"FailCount":"94",
"InProcessCount":"0"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}
title: DescribeStratety
sidebar_position: 3
DescribeStratety
Description
call the DescribeStratety interface to query the setting details of the baseline check policy.
Request Method
POST
Request Path
/apsara/route/aegis/DescribeStratety
Request Parameters Common Parameters
| Name | Location | Type | Required | Sample value | Description |
|---|---|---|---|---|---|
| SourceIp | BODY | string | No | 1.2.3.4 | access source IP address. |
| regionId | BODY | string | Yes | No sample value for this parameter. | region id |
| Lang | BODY | string | No | zh | the language type of the request and receive message. zh: Chinese en: English |
| StrategyIds | BODY | string | No | test1,test2,test3 | baseline check policy ID, multiple separated by commas. |
| version | BODY | string | No | 2016-01-01 | version of api |
Return data
| Name | Type | Sample value | Description |
|---|---|---|---|
| CycleStartTime | integer | 6 | the baseline check start time can be performed at four time points: 0:00, 06:00, 12:00, 18:00. |
| EcsCount | integer | 5 | the number of servers performing baseline detection in this baseline check policy. |
| PassRate | integer | 80 | last detection pass rate. |
| RequestId | string | 16B9826C-B99F-4F8A-8048-EA81D6D3DE8B | request ID of the result. |
| CycleDays | integer | 1 | baseline check cycle. 1: Every 1 day 3: Every 3 days 7: Every 7 days 30: every 30 days |
| ConfigTargets | array | No sample value for this parameter. | baseline check policy association grouping information. |
| Flag | string | add | association identifier. |
| RiskCount | integer | 5 | number of selected baseline check items. |
| Name | string | test | policy name. |
| Target | string | 3259405 | associated group ID. |
| ExecStatus | integer | 1 | execution status. 1: Not executed 2: Execution |
| Type | integer | 1 | the type of baseline check policy. 1: default policy 2: user-defined policy |
| ProcessRate | integer | 80 | baseline check progress. |
| Strategies | array | No sample value for this parameter. | baseline check policy information. |
| TargetType | string | groupId | association type. |
| Id | integer | 212635 | policy ID. |
Example
Successful Response example
{
"CycleStartTime":"6",
"EcsCount":"5",
"PassRate":"80",
"RequestId":"16B9826C-B99F-4F8A-8048-EA81D6D3DE8B",
"CycleDays":"1",
"ConfigTargets":"",
"Flag":"add",
"RiskCount":"5",
"Name":"test",
"Target":"3259405",
"ExecStatus":"1",
"Type":"1",
"ProcessRate":"80",
"Strategies":"",
"TargetType":"groupId",
"Id":"212635"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}
title: DescribeSummaryInfo
sidebar_position: 3
DescribeSummaryInfo
Description
Call this interface to query the security score information of assets, such as the security score of assets, the number of protected assets, and the number of unprotected assets.
Request Method
POST
Request Path
/apsara/route/aegis/DescribeSummaryInfo
Request Parameters Common Parameters
| Name | Location | Type | Required | Sample value | Description |
|---|---|---|---|---|---|
| SourceIp | BODY | string | No | 1.2.3.4 | access the IP address of the source. |
| regionId | BODY | string | Yes | No sample value for this parameter. | region id |
| Lang | BODY | string | No | zh | the language type of the request and receive message. zh: Chinese en: English |
| version | BODY | string | No | 2016-01-01 | version of api |
Return data
| Name | Type | Sample value | Description |
|---|---|---|---|
| AegisClientOnlineCount | integer | 127 | number of protected assets. |
| RequestId | string | D40198E1-6EA8-482E-B3C7-D9573D75C0CA | request ID of the result. |
| AegisClientOfflineCount | integer | 12 | the number of unprotected assets. |
| SecurityScore | integer | 44 | the security score of the asset. The score is explained as follows: 95-100: indicates that the asset is in good security status. 85-94: indicates that assets have potential safety hazards, and it is recommended to strengthen the safety protection system as soon as possible. 70-84: indicates that there are many potential safety hazards in assets, and it is recommended to strengthen the safety protection system in time. below 69: indicates that the ability of assets to defend against hacker intrusion is very weak, and it is recommended to strengthen the security protection system as soon as possible. |
| Success | boolean | true | request status of the result. |
Example
Successful Response example
{
"AegisClientOnlineCount":"127",
"RequestId":"D40198E1-6EA8-482E-B3C7-D9573D75C0CA",
"AegisClientOfflineCount":"12",
"SecurityScore":"44",
"Success":"true"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}